home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / info-service / gopher / Unix / GopherTools / jughead / ReadMe < prev   
Encoding:
Text File  |  1993-04-09  |  6.1 KB  |  152 lines
  1. jughead is copyright 1993, University of Utah Computer Center.
  2. This source may be freely distributed as long as this copyright
  3. notice remains intact, and distribution is in no way used for any
  4. monetary gain, by any institution, business, person, or persons.
  5.  
  6. jughead is a tool for getting menu information from various gopher
  7. servers, and is an acronym for:
  8.     Jonzy's Universal Gopher Hierarchy Excavation And Display
  9.  
  10. jughead was written in ANSI C, developed on an IBM RS6000, and
  11. should port easily to any ANSI C conformant environment.
  12.  
  13. It is anticipated this program will be a tool for administrators
  14. in gopherspace.  If you make any changes to the sources, please
  15. send me a copy.
  16.  
  17. Release: version 0.5_beta, released:.
  18. Modified the code to support a secondary hash table.  The table that
  19. gets read into memory is much smaller than previously, while the time
  20. to do the boolean operations and search the tables takes slightly longer, however, I doubt users will notice the difference.
  21. Note:  This is a major change with the index tables.  When running
  22. jughead with the -B flag, you no longer direct stdout to a file.
  23. What happens now is 2 files automaticlly get created, 1 with a ".ix" and
  24. the other with a ".ih" extention on the file created with the -b option.
  25. Furthermore when invoking jughead as a search engine with the -S flag
  26. you only need to give the name of the database file created with the -b 
  27. flag.
  28.  
  29. Release: version 0.4_beta, released: April 3, 1993.
  30. Added support for the 'a', 'A', and 't' options, which print the
  31. port host number of directories, port, host, the directories, and
  32. the time required to process a menu or build the index table or
  33. load the index table into memory respectively.
  34. Added the code from Mic Kaczmarczik: mic@bongo.cc.utexas.edu, which
  35. supports an optional -p port flag when running as a search engine.
  36. When using the -b option the datafile now gets sorted to remove all
  37. duplicates, and no longer gets written to datafile.sorted.
  38. The -o and -O flags are now meaningless and may soon disappear.
  39.  
  40. Release: version 0.3.1_beta, released: March 28, 1993.
  41.   Fixed a problem using vsprintf compiled on sun.
  42.  
  43. Release: version 0.3_beta, released: March 28, 1993.
  44.   Modifications include consolidating various #defines into the
  45.   Makefile.  Now keeps track of hosts we can't connect to and will
  46.   not attempt to connect to these hosts again.
  47.   Added support for compilation on a sun.
  48.  
  49. Initial release: version 0.2_beta, released: March 25, 1993.
  50.  
  51. jughead can be acquired via gopher by gophering to gopher.cc.utah.edu
  52. and looking in:
  53.    About U of U Gopher
  54.       Gopher Tools
  55.          jughead
  56.             as ReadMe and jughead.VERS.tar.Z
  57. or via anonymous ftp from ftp.cc.utah.edu in /pub/gopher/GopherTools
  58. as ReadMe and jughead.VERS.tar.Z, where ".VERS" is the current version.
  59.  
  60. The file jughead.VERS.tar.Z is a compressed tar file which contains:
  61.     dirTree.c
  62.     Makefile
  63.     jughead.1
  64.     jughead.c
  65.     search.c
  66.     sockets.c
  67.     dirTree.h
  68.     tree.c
  69.     tree.h
  70.     utils.c
  71.     utils.h
  72.  
  73. Create yourself a directory for jughead, which should not be in a
  74. gopher data directory, and download the file jughead.VERS.tar.Z.
  75.  
  76. Once you have downloaded jughead.VERS.tar.Z, where "VERS" is the version
  77. of jughead, the following command will uncompress and untar the files:
  78.     uncompress -c < jughead.VERS.tar.Z | tar xfv -
  79.  
  80. To view the man page, prior to running make install you can:
  81.     make viewman
  82.  
  83. To make the jughead application you should edit the Makefile and verify
  84. the following values are correct:
  85.   THEVERSION      The version of jughead, only edit this if you make changes.
  86.   THECATCOMMAND   The cat system command, the %s is required.
  87.   THERMCOMMAND    The rm system command, the %s is required.
  88.   THESORTCOMMAND  The sort system command, the %s is required.
  89.   THETMPFILENAME  The location and name of jughead's temporary file.
  90.   THEPORT2USE     The port to use when jughead is a search engine.
  91.   DESTDIR         The location of the jughead executable.  You may not want
  92.           this to be publicly accessible.
  93.   DESTMAN         The location of the jughead man page.
  94.   VARARGS      Commented out if you have <stdarg.h>.
  95.   VSPRINTTYPE      The type vsprintf() returns.
  96.   PROTOTYPES      Uncommented if you want to use prototypes.
  97.   NOWARNINGS      Uncommented if you don't want to see any compiler warnings.
  98.   OPTIMIZATION      Any optimization flags you want to have.
  99.  
  100.  
  101. Now do a "make", "make all", or "make install" to compile jughead.  If
  102. you get any compilation errors please inform me of the problem.
  103.  
  104. The steps I did to get jughead running as a server follow:
  105.  jughead -tb data gopher.cc.utah.edu -x apogee.cc.utah.edu 3000 .utah.edu
  106.  jughead -tB data
  107.  jughead -tS data -l data.log &
  108.  
  109. Create a link file somewhere in your gopher data directory.  Mine looks like:
  110.   Name=Search all UofU menus using jughead
  111.   Numb=4
  112.   Type=7
  113.   Port=3000
  114.   Path=
  115.   Host=gopher.cc.utah.edu
  116.  
  117.  
  118. There exists a mailing list for discussion about jughead called:
  119. jughead-news@lists.utah.edu    To get on this mailing list send
  120. mail to: jughead-news-request@lists.utah.edu
  121.  
  122. Things still to do:
  123.   1)    Allow a list of host exceptions, the hosts not to traverse.
  124.  
  125.   2)    Use the Path field in the link file to specify which database
  126.     to use, load the database into memory, do the search, and
  127.     release the memory.  Maybe have this as an option.
  128.     How about initialy start up with no tables cached in memory,
  129.     when we receive a query read the appropriate table into memory
  130.     if there is none, and only release the memory if a new query
  131.     refers to an alternate database?
  132.  
  133.   3)    Add the ability to query other jugheads.
  134.  
  135.   4)    Consolidate the tree.c and dirTree.c files.
  136.  
  137.   5)    Either reenable or remove support for the -o and -O flags?
  138.  
  139.   6)    Clean up the code dealing with the hash tables or create a
  140.     flag that does not utilize the secondary hash table?
  141.  
  142.   7)    Use vfork() instead of fork() when acting as a search engine
  143.     to eliminate, as much as possible, any memory duplication.
  144.  
  145.   8)    Implement a no feed back flag which will give no feed back when
  146.     building the hash tables, which will make the creation of the
  147.     hash tables speed up by approximately 20 percent.
  148.  
  149. Please email source changes, complaints, or suggestions to:
  150.     Rhett "Jonzy" Jones
  151.     jonzy@cc.utah.edu
  152.